Header Bar
Type
widget
Summary
A header bar intended for use by mobile apps.
The header bar has a label, which is displayed as its title, along with a set of actions. Each action has a name, which is used to identify it internally, and an icon and label which are displayed (depending on the chosen itemStyle). One of the actions can optionally be displayed to the left of the header bar's title, when the firstItemLeft property is enabled.
The header bar widget provides two theme modes, one for Android apps and one for iOS apps. By default, it automatically selects the appropriate one depending on which platform it is running on. To temporarily select a non-default different appearance, set the theme property.
The header bar widget works well when paired with the navigation bar widget.
Description
A header bar intended for use by mobile apps.
The header bar has a label, which is displayed as its title, along with a set of actions. Each action has a name, which is used to identify it internally, and an icon and label which are displayed (depending on the chosen itemStyle). One of the actions can optionally be displayed to the left of the header bar's title, when the firstItemLeft property is enabled.
The header bar widget provides two theme modes, one for Android apps and one for iOS apps. By default, it automatically selects the appropriate one depending on which platform it is running on. To temporarily select a non-default different appearance, set the theme property.
The header bar widget works well when paired with the navigation bar widget.
Related
property: firstItemLeft, itemIcons, itemLabels, itemNames, itemStyle, label, theme
Children Properties
Message
| Name | Summary | Syntax |
|---|---|---|
| mouseUp | Sent when the header bar is clicked | mouseUp |
Property
| Name | Summary | Syntax |
|---|---|---|
| foreColor | The text color | get the foreColor of <widget> set the foreColor of <widget> to <pColor> |
| backColor | The background color | get the backColor of <widget> set the backColor of <widget> to <pColor> |
| hiliteColor | The color of the actions' icons and text | get the hiliteColor of <widget> set the hiliteColor of <widget> to <pColor> |
| borderColor | The border color | get the borderColor of <widget> set the borderColor of <widget> to <pColor> |
| showBorder | Whether the header bar has a dividing line at the bottom | get the showBorder of <widget> set the showBorder of <widget> to {true | false} |
| opaque | Whether the background of the header bar is filled | get the opaque of <widget> set the opaque of <widget> to {true | false} |
| itemIcons | The icons for actions when not highlighted. | get the itemIcons of <widget> set the itemIcons of <widget> to <iconNames> |
| itemStyle | The display style for header actions. | get the itemStyle of <widget> set the itemStyle of <widget> to <actionStyle> |
| firstItemLeft | Whether to display the first action on the left | get the firstItemLeft of <widget> set the firstItemLeft of <widget> to { true | false } |
| itemNames | The identifying names for header actions. | get the itemNames of <widget> set the itemNames of <widget> to <names> |
| hilitedItemIcons | The icons for actions when highlighted. | get the hilitedItemIcons of <widget> set the hilitedItemIcons of <widget> to <iconNames> |
| label | The title displayed by the header bar. | get the label of <widget> set the label of <widget> to <title> |
| itemArray | The full header action data. | get the itemArray of <widget> set the itemArray of <widget> to <array> |
| showLabel | Whether or not to display a title | get the showLabel of <widget> set the showLabel of <widget> to {true | false} |
| mouseAction | The header action that the mouse pointer is currently over. | get the mouseAction of <widget> |
| theme | The theme to use when drawing the header bar. | get the theme of <widget> set the theme of <widget> to <widgetTheme> |
| itemLabels | The labels for header actions. | get the itemLabels of <widget> set the itemLabels of <widget> to <labels> |